/**
 * Copyright (c) 2009 Cycle Information Technology
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this 
 * software and associated documentation files (the "Software"), to deal in the Software 
 * without restriction, including without limitation the rights to use, copy, modify, 
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to 
 * permit persons to whom the Software is furnished to do so, subject to the following 
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies 
 * or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 */
package com.cycleit.cycleframework.interfaces {
	import com.cycleit.cycleframework.entity.NavigationView;
	
	import flash.display.DisplayObjectContainer;
	import flash.events.IEventDispatcher;

	/**
	 * Interfaz que deben implementar todos los componentes visuales que queramos que 
	 * sean gestionados por el framework.
	 */ 
	public interface INavigableView extends IEventDispatcher {
		/**
		 * Método que en función de nextState, debe decidir que vista cargar
		 * en mainContainer
		 *  
		 * @param nextState Nueva vista a cargar dentro de mainContainer
		 * 
		 */		
		function navigateTo(nextState:String):void;
		/**
		 * Contenedor que usaremos para introducir el contenido variable de un
		 * componente de vista
		 *  
		 * @return Container contenedor principal de nuestra aplicación.
		 * 
		 */		
		function get mainContainer():DisplayObjectContainer;
		/**
		 * Nos proveerá de la gestión de vistas del framework para el componente 
		 *  
		 * @return NavigationView provee de la gestión de vistas del framework para el componente
		 * 
		 */		
		function get navigationView():NavigationView; 
	}
}